v5.0.0

Compare Source

BREAKING CHANGES

Apollo Server v5 has very few breaking API changes. It is a small upgrade focused largely on adjusting which versions of Node.js and Express are supported.

Read our migration guide for more details on how to update your app.

• Dropped support for Node.js v14, v16, and v18, which are no longer under long-term support from the Node.js Foundation. Apollo Server 5 supports Node.js v20 and later; v24 is recommended. Ensure you are on a non-EOL version of Node.js before upgrading Apollo Server.
• Dropped support for versions of the graphql library older than v16.11.0. (Apollo Server 4 supports graphql v16.6.0 or later.) Upgrade graphql before upgrading Apollo Server.
• Express integration requires a separate package. In Apollo Server 4, you could import the Express 4 middleware from @apollo/server/express4, or you could import it from the separate package @as-integrations/express4. In Apollo Server 5, you must import it from the separate package. You can migrate your server to the new package before upgrading to Apollo Server 5. (You can also use @as-integrations/express5 for a middleware that works with Express 5.)
• Usage Reporting, Schema Reporting, and Subscription Callback plugins now use the Node.js built-in fetch implementation for HTTP requests by default, instead of the node-fetch npm package. If your server uses an HTTP proxy to make HTTP requests, you need to configure it in a slightly different way. See the migration guide for details.
• The server started with startStandaloneServer no longer uses Express. This is mostly invisible, but it does set slightly fewer headers. If you rely on the fact that this server is based on Express, you should explicitly use the Express middleware.
• The experimental support for incremental delivery directives @defer and @stream (which requires using a pre-release version of graphql v17) now explicitly only works with version 17.0.0-alpha.2 of graphql. Note that this supports the same incremental delivery protocol implemented by Apollo Server 4, which is not the same protocol in the latest alpha version of graphql. As this support is experimental, we may switch over from "only alpha.2 is supported" to "only a newer alpha or final release is supported, with a different protocol" during the lifetime of Apollo Server 5.
• Apollo Server is now compiled by the TypeScript compiler targeting the ES2023 standard rather than the ES2020 standard.
• Apollo Server 5 responds to requests with variable coercion errors (eg, if a number is passed in the variables map for a variable declared in the operation as a String) with a 400 status code, indicating a client error. This is also the behavior of Apollo Server 3. Apollo Server 4 mistakenly responds to these requests with a 200 status code by default; we recommended the use of the status400ForVariableCoercionErrors: true option to restore the intended behavior. That option now defaults to true.
• The unsafe precomputedNonce option to landing page plugins (which was only non-deprecated for 8 days) has been removed.

Patch Changes

There are a few other small changes in v5:

• #​8076 5b26558 Thanks @​valters! - Fix some error logs to properly call logger.error or logger.warn with this set. This fixes errors or crashes from logger implementations that expect this to be set properly in their methods.

• #​7515 100233a Thanks @​trevor-scheer! - ApolloServerPluginSubscriptionCallback now takes a fetcher argument, like the usage and schema reporting plugins. The default value is Node's built-in fetch.

• Updated dependencies [100233a]:

  • @​apollo/server-gateway-interface@​2.0.0

v4.12.2

Compare Source

(No change; there is a change to the @apollo/server-integration-testsuite used to test integrations, and the two packages always have matching versions.)

v4.12.1

Compare Source

Patch Changes

• #​8064 41f98d4 Thanks @​glasser! - Update README.md to recommend Express v5 integration now that Express v5 is released.

v4.12.0

Compare Source

Minor Changes

• #​8054 89e3f84 Thanks @​clenfest! - Adds a new graphql-js validation rule to reject operations that recursively request selections above a specified maximum, which is disabled by default. Use configuration option maxRecursiveSelections=true to enable with a maximum of 10,000,000, or maxRecursiveSelections=<number> for a custom maximum. Enabling this validation can help avoid performance issues with configured validation rules or plugins.

Patch Changes

• #​8031 2550d9f Thanks @​slagiewka! - Add return after sending 400 response in doubly escaped JSON parser middleware

v1.3.0

Minor Changes

• Enable Source link for debugging enhancements (#​60) @​damienpontifex

Patch Changes

• chore(deps): update all non-major dependencies (#​41) @​renovate
• chore(deps): update dependency microsoft.sourcelink.github to v8 (#​57) @​renovate

Other Changes

• Add Codeowners (#​56) @​svc-secops

v1.2.1

Patch Changes

• fix: new NonResolvableKey attribute (#​54) @​dariuszkuc

Other Changes

• add compatibility warning (#​50) @​dariuszkuc

v1.2.0

Minor Changes

• feat: expose IRequestExecutorBuilder extensions to apply schema directives (#​47) @​dariuszkuc

Patch Changes

• fix: use implicit binding for federated POCO (#​39) @​dariuszkuc

Other Changes

• chore(deps): update hotchocolate to v13.6.1 (#​42 #​43) @​renovate
• chore(renovate): group HotChocolate updates together (#​40) @​dariuszkuc

v1.1.0

Minor Changes

Adds support for HotChocolate v13.6.0.

v1.0.0

Apollo Federation for HotChocolate

Apollo Federation is a powerful, open architecture that helps you create a unified supergraph that combines multiple GraphQL APIs. ApolloGraphQL.HotChocolate.Federation provides Apollo Federation support for building subgraphs in the HotChocolate ecosystem. Individual subgraphs can be run independently of each other but can also specify relationships to the other subgraphs by using Federated directives. See Apollo Federation documentation for details.

Generating Federated Schemas

ApolloGraphQL.HotChocolate.Federation package is published to Nuget. Update your .csproj file with following package references

  <ItemGroup>
    <!-- make sure to also include HotChocolate package -->
    <PackageReference Include="HotChocolate.AspNetCore" Version="13.5.1" />
    <!-- federation package -->
    <PackageReference Include="ApolloGraphQL.HotChocolate.Federation" Version="$LatestVersion" />
  </ItemGroup>

After installing the necessary packages, you need to register Apollo Federation with your GraphQL service. You need to opt-in to Federation v1 or v2 schema by invoking corresponding builder extension

var builder = WebApplication.CreateBuilder(args);

builder.Services
    .AddGraphQLServer()
    // .AddApolloFederation() // use this instead if you want to opt-in to fed v1 
    .AddApolloFederationV2() 
    // register your types and services
    ;

var app = builder.Build();
app.MapGraphQL();
app.Run();

Apollo Federation requires subgraphs to provide some additional metadata to make them supergraph aware. Entities are GraphQL objects that can be uniquely identified across the supergraph by the specified @keys. Since entities can be extended by various subgraphs, we need an extra entry point to access the entities, i.e. subgraphs need to implement reference resolvers for entities that they support.

All federated directives are provided as attributes that can be applied directly on classes/fields/methods. Alternatively, if you need more granular control, you can use code first approach and manually populate federation information on the underlying GraphQL type descriptor. All federated directives expose corresponding methods on the applicable descriptor. Example attribute usage

[Key("id")]
public class Product
{
    public Product(string id, string name, string? description)
    {
        Id = id;
        Name = name;
        Description = description;
    }

    [ID]
    public string Id { get; }

    public string Name { get; }

    public string? Description { get; }

    // assumes ProductRepository with GetById method exists
    // reference resolver method must be public static
    [ReferenceResolver]
    public static Product GetByIdAsync(
        string id,
        ProductRepository productRepository)
        => productRepository.GetById(id);
}

Federation v1 directives

• Extends applicable on objects, see @extends documentation
• External applicable on fields, see @external documentation
• Key applicable on objects, see @key documentation
• Provides applicable on fields, see @provides documentation
• Requires applicable on fields, see @requires documentation

Federation v2 directives (includes all of the v1 directives)

• ApolloTag applicable on schema, see @tag documentation
• ApolloAuthenticated (since v2.5) applicable on enum, field, interface and object, @authenticated documentation
• ComposeDirective (since v2.1) applicable on schema, see @composeDirective documentation
• Contact applicable on schema, see @contact usage
• Inaccessible applicable on all type definitions, see @inaccessible documentation
• InterfaceObject (since v2.3) applicable on objects, see @interfaceObject documentation
• KeyInterface applicable on interfaces, see entity interface @key documentation
• Link applicable on schema, see @link documentation
• RequiresScopes (since v2.5) applicable on enum, field, interface and object, @requiresScopes documentation
• Shareable applicable on schema, see @shareable documentation

Entity resolution

• Map applicable on entity resolver method paramaters, allows you to map complex argument to a simpler representation value, e.g. [Map("foo.bar")] string bar
• ReferenceResolver applicable on public static methods within an entity class to indicate entity resolver

v0.3.0

Minor Changes

• feat: support @authenticated and @requiresScopes (#​33) @​dariuszkuc
• feat: new AddApolloFederationV2 that accepts target version (#​32) @​dariuszkuc
• feat: allow users specifying supported federation version (#​23) @​dariuszkuc

Other Changes

• chore(deps): update dependency coverlet.msbuild to v6 (#​31) @​renovate
• chore(deps): update dependency snapshooter.xunit to v0.13.0 (#​29) @​renovate
• chore(deps): update actions/checkout action to v4 (#​12) @​renovate
• chore(deps): update xunit-dotnet monorepo to v2.5.3 (#​30) @​renovate
• chore(deps): update dependency moq to v4.20.69 (#​28) @​renovate
• chore(deps): update dependency microsoft.net.test.sdk to v17.7.2 (#​27) @​renovate
• chore(deps): update dependency coverlet.msbuild to v3.2.0 (#​26) @​renovate
• chore: simplify project structure (#​25) @​dariuszkuc